<?php

/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4 fdm=marker: */

/**
 * LightBot_ILogger
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category  LightBot
 * @package   LightBot
 * @copyright Copyright (c) 2008 Olivier Hoareau <hoareau.olivier@gmail.com>
 * @author    Olivier Hoareau <hoareau.olivier@gmail.com>
 * @license   License http://framework.zend.com/license   New BSD License
 * @version   $Id:$
 */

// {{{ LightBot_ILogger

/**
 * Logger interface
 *
 * @category  LightBot
 * @package   LightBot
 * @copyright Copyright (c) 2008 Olivier Hoareau <hoareau.olivier@gmail.com>
 * @author    Olivier Hoareau <hoareau.olivier@gmail.com>
 * @license   License http://framework.zend.com/license   New BSD License
 */
interface LightBot_ILogger
{
    // {{{ getId()

    /**
     * Returns the identifier of this logger
     *
     * @return string the id
     */
    public function getId();

    // }}}
    // {{{ configure()

    /**
     * Configures the logger
     *
     * @param  array $conf the configuration to apply
     * @return LightBot_ILogger $this
     */
    public function configure($conf);

    // }}}
    // {{{ log()

    /**
     * Log the specified debug message
     *
     * @param string $msg the message
     * @return LightBot_ILogger $this
     */
    public function log($msg);

    // }}}
    // {{{ debug()

    /**
     * Log the specified debug message
     *
     * @param string $msg the message
     * @return LightBot_ILogger $this
     */
    public function debug($msg);

    // }}}
    // {{{ error()

    /**
     * Log the specified error message
     *
     * @param string $msg the message
     * @return LightBot_ILogger $this
     */
    public function error($msg);

    // }}}
    // {{{ fatal()

    /**
     * Log the specified fatal message
     *
     * @param string $msg the message
     * @return LightBot_ILogger $this
     */
    public function fatal($msg);

    // }}}
    // {{{ info()

    /**
     * Log the specified info message
     *
     * @param string $msg the message
     * @return LightBot_ILogger $this
     */
    public function info($msg);

    // }}}
    // {{{ warn()

    /**
     * Log the specified warning message
     *
     * @param string $msg the message
     * @return LightBot_ILogger $this
     */
    public function warn($msg);

    // }}}
}   

// }}}

/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * c-hanging-comment-ender-p: nil
 * End:
 */
